feat(docs): Private Links official documentation#3466
Conversation
…m private networking docs
…from private networking docs
|
WalkthroughAdds a new "Private networking" documentation group to the site navigation and introduces four documentation changes: an overview page describing AWS PrivateLink-based architecture and usage; an AWS Console setup guide with step-by-step provisioning, troubleshooting, and cleanup instructions; a troubleshooting page for common PrivateLink issues (including "Private link not found"); and a short prerequisites tip in the Drizzle framework guide directing private-VPC Postgres users to the Private networking docs. All changes are documentation-only. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/private-networking/aws-console-setup.mdx`:
- Around line 226-227: Update the inconsistent step reference in the "VPC
Endpoint Service name" bullet so it points to Step 4 instead of Step 3: locate
the line containing the text "VPC Endpoint Service name: paste the
`com.amazonaws.vpce.<region>.vpce-svc-...` value from Step 3." and change "Step
3" to "Step 4" to match where users actually copy the endpoint service name.
- Around line 38-43: In the "Choose a target type" Step (the list under the Step
title "Choose a target type") remove the "- **Lambda** for Lambda-backed
services" bullet because Network Load Balancers do not support Lambda targets,
and update the remaining bullets to only list "**IP addresses**, **Instances**,
and **Application Load Balancer**; optionally add a short clarifying sentence
that Lambda targets are not supported by NLBs to prevent confusion.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 9069974f-0eb9-400f-b3bc-d48539ab1df2
⛔ Files ignored due to path filters (8)
docs/images/priv-connections-allow-principal.pngis excluded by!**/*.pngdocs/images/priv-connections-copy-endpoint-name.pngis excluded by!**/*.pngdocs/images/priv-connections-create-endpoint-service.pngis excluded by!**/*.pngdocs/images/priv-connections-network-load-balancer-add-target-group.pngis excluded by!**/*.pngdocs/images/priv-connections-network-load-balancer-basic.pngis excluded by!**/*.pngdocs/images/priv-connections-network-load-balancer-vpc-az.pngis excluded by!**/*.pngdocs/images/priv-connections-target-group-basic.pngis excluded by!**/*.pngdocs/images/priv-connections-target-group-register-nlb.pngis excluded by!**/*.png
📒 Files selected for processing (5)
docs/docs.jsondocs/guides/frameworks/drizzle.mdxdocs/private-networking/aws-console-setup.mdxdocs/private-networking/overview.mdxdocs/private-networking/troubleshooting.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Analyze (python)
- GitHub Check: Analyze (actions)
- GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{js,ts,jsx,tsx,json,md,yaml,yml}
📄 CodeRabbit inference engine (AGENTS.md)
Format code using Prettier before committing
Files:
docs/docs.json
docs/**/docs.json
📄 CodeRabbit inference engine (docs/CLAUDE.md)
docs/**/docs.json: Main documentation config must be defined indocs.jsonwhich includes navigation structure, theme, and metadata
Navigation structure indocs.jsonshould be organized usingnavigation.dropdownswith groups and pages
Files:
docs/docs.json
docs/**/*.mdx
📄 CodeRabbit inference engine (docs/CLAUDE.md)
docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from@trigger.dev/sdkin code examples (never from@trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences:typescript,bash,json
Files:
docs/guides/frameworks/drizzle.mdxdocs/private-networking/troubleshooting.mdxdocs/private-networking/aws-console-setup.mdxdocs/private-networking/overview.mdx
🧠 Learnings (8)
📓 Common learnings
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:19.869Z
Learning: In the triggerdotdev/trigger.dev repository, docs PRs are often written as companions to implementation PRs (e.g., PR `#3200` documents features being added in PR `#3196`). When reviewing docs PRs, the documented features may exist in a companion/companion PR branch rather than main. Always check companion PRs referenced in the PR description before flagging missing implementations.
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: New documentation pages must be added to the navigation structure in `docs.json` under the correct group after creating the MDX file
Applied to files:
docs/docs.json
📚 Learning: 2026-03-02T12:43:02.539Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: docs/CLAUDE.md:0-0
Timestamp: 2026-03-02T12:43:02.539Z
Learning: Applies to docs/**/docs.json : Navigation structure in `docs.json` should be organized using `navigation.dropdowns` with groups and pages
Applied to files:
docs/docs.json
📚 Learning: 2026-03-25T15:29:25.889Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2026-03-25T15:29:25.889Z
Learning: Run `npx trigger.devlatest init` to initialize a new Trigger.dev project
Applied to files:
docs/guides/frameworks/drizzle.mdx
📚 Learning: 2026-03-25T15:29:25.889Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2026-03-25T15:29:25.889Z
Learning: Set the `TRIGGER_SECRET_KEY` environment variable when triggering tasks from backend code (available on the API keys page in the Trigger.dev dashboard)
Applied to files:
docs/guides/frameworks/drizzle.mdx
📚 Learning: 2026-03-25T15:29:25.889Z
Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2026-03-25T15:29:25.889Z
Learning: Run `npx trigger.devlatest dev` to start the Trigger.dev development server
Applied to files:
docs/guides/frameworks/drizzle.mdx
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.
Applied to files:
docs/guides/frameworks/drizzle.mdxdocs/private-networking/troubleshooting.mdxdocs/private-networking/aws-console-setup.mdxdocs/private-networking/overview.mdx
📚 Learning: 2026-03-25T00:18:24.123Z
Learnt from: isshaddad
Repo: triggerdotdev/trigger.dev PR: 3262
File: docs/guides/frameworks/nango.mdx:71-71
Timestamp: 2026-03-25T00:18:24.123Z
Learning: In trigger.dev framework guide MDX files under docs/guides/frameworks/**, when you include TypeScript code snippets, use the code-fence language tag `ts` (not `typescript`) for the opening ``` fence. Keep this consistent across all framework guides so syntax highlighting works uniformly (e.g., Next.js, Sequin, Prisma, Remix, Drizzle).
Applied to files:
docs/guides/frameworks/drizzle.mdx
🪛 LanguageTool
docs/private-networking/aws-console-setup.mdx
[style] ~20-~20: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...A resource in a VPC subnet that you want to expose (RDS instance, ElastiCache clust...
(REP_WANT_TO_VB)
🔇 Additional comments (4)
docs/docs.json (1)
132-139: Private networking docs are correctly wired into sidebar navigation.The new group and page slugs are structured correctly under the existing
Documentationdropdown.As per coding guidelines, navigation in
docs.jsonshould be organized withnavigation.dropdownsusing groups and pages.docs/guides/frameworks/drizzle.mdx (1)
27-31: Nice addition to steer users away from public DB exposure.This tip is well-placed and links directly to the private networking setup path.
docs/private-networking/troubleshooting.mdx (1)
1-45: Troubleshooting page structure and fix path look solid.The page is concise, actionable, and the remediation sequence is easy to follow.
docs/private-networking/overview.mdx (1)
1-136: Overview page is clear, well-structured, and implementation-aligned.The conceptual flow, isolation model, and follow-up links read consistently and are easy to navigate.
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/private-networking/aws-console-setup.mdx`:
- Around line 190-192: The fenced code block currently uses the disallowed
language tag "text" for the ARN snippet; replace the opening fence ```text with
the approved tag ```bash so the block becomes ```bash followed by the ARN line
`arn:aws:iam::<account-id>:root` and the closing ```, ensuring the snippet
complies with the required language-tag policy.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 9254bfc5-9e00-4aa7-8bbc-9b80dd6fd23d
📒 Files selected for processing (2)
docs/private-networking/aws-console-setup.mdxdocs/private-networking/overview.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/private-networking/overview.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: check-broken-links
- GitHub Check: Analyze (actions)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (python)
- GitHub Check: Mintlify Deployment
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.mdx
📄 CodeRabbit inference engine (docs/CLAUDE.md)
docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from@trigger.dev/sdkin code examples (never from@trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences:typescript,bash,json
Files:
docs/private-networking/aws-console-setup.mdx
🧠 Learnings (2)
📓 Common learnings
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:19.869Z
Learning: In the triggerdotdev/trigger.dev repository, docs PRs are often written as companions to implementation PRs (e.g., PR `#3200` documents features being added in PR `#3196`). When reviewing docs PRs, the documented features may exist in a companion/companion PR branch rather than main. Always check companion PRs referenced in the PR description before flagging missing implementations.
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.
Applied to files:
docs/private-networking/aws-console-setup.mdx
🪛 LanguageTool
docs/private-networking/aws-console-setup.mdx
[style] ~20-~20: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...A resource in a VPC subnet that you want to expose (RDS instance, ElastiCache clust...
(REP_WANT_TO_VB)
🔇 Additional comments (1)
docs/private-networking/aws-console-setup.mdx (1)
15-274: Strong step-by-step structure and troubleshooting coverage.The flow from prerequisites → AWS setup → Trigger.dev verification is clear and actionable, and the troubleshooting/cleanup sections make this page practical to use.
2 participants
No description provided.